<html xmlns:fn="http://www.w3.org/2005/xpath-functions"><head><meta http-equiv="Content-Type" content="text/html; charset=UTF-8"><title>jsx3.gui.Matrix.EditMask Summary</title><link rel="stylesheet" TYPE="text/css" media="screen" href="../../styles.css"><link rel="stylesheet" TYPE="text/css" media="print" href="../../styles-print.css"></head><body><div class="header"><span><a href="../../overview-summary.html">Overview</a></span></div><a name="class:jsx3.gui.Matrix.EditMask"><h4><span><a target="classFrame" href="../../jsx3/gui/.html">jsx3.gui</a></span></h4><h1>interface Matrix.EditMask</h1></a><div class="inheritance"><span class="arrow"></span><span><a target="classFrame" href="../../jsx3/gui/Matrix/EditMask.html">jsx3.gui.Matrix.EditMask</a></span></div><hr><div class="declaration-class">interface Matrix.EditMask<br></div><div class="detaildesc">The interface defining the methods that affect the behavior of an object used as an edit mask in a matrix column.
<p></p>
If an object is placed in the DOM as a child of a matrix column, it will be used as an edit mask. Any methods
in this interface that the object does not implement will be inserted into the object. This interface is a "loose"
interface because the class of an edit mask does not need to implement it in its class declaration. The class
simply needs to define any methods whose default behavior it wishes to override.
<p></p>
Any edit mask that implements the <code>jsx3.gui.Form</code> interface will have the methods in this interface
inserted into it. If the edit mask does not implement <code>jsx3.gui.Form</code> but extends
<code>jsx3.gui.Block</code>, the methods in the <code>jsx3.gui.Matrix.BlockMask</code> interface are inserted
instead.
</div><h4 class="detail">Since:</h4><div class="indent">3.2
 </div><h4 class="detail">See Also:</h4><div class="indent"><span><a target="classFrame" href="../../jsx3/gui/Matrix/BlockMask.html">jsx3.gui.Matrix.BlockMask</a></span></div><hr><table class="summary"><tr><th colspan="2">Method Summary</th></tr><tr><td class="type"><span class="$"><span class="$">void</span></span></td><td class="desc"><div class="declaration"><span><a class="member" href="#method:commitEditMask">commitEditMask</a></span>(<span class="$">{<span><a target="classFrame" href="../../jsx3/gui/Event.html">jsx3.gui.Event</a></span>}</span>objEvent, <span class="$">{<span><a target="classFrame" href="../../Boolean.html">boolean</a></span>}</span>bKeepOpen)</div><div class="summarydesc">Commits the current edit session of this edit mask.</div></td></tr><tr><td class="type"><span class="$"><span><a target="classFrame" href="../../Boolean.html">boolean</a></span></span></td><td class="desc"><div class="declaration"><span><a class="member" href="#method:emBeginEdit">emBeginEdit</a></span>(<span class="$">{<span><a target="classFrame" href="../../String.html">String</a></span>}</span>strValue, <span class="$">{<span><a target="classFrame" href="../../Object.html">Object</a></span>&lt;<span><a target="classFrame" href="../../String.html">String</a></span>, <span><a target="classFrame" href="../../Number.html">int</a></span>&gt;}</span>objTdDim, <span class="$">{<span><a target="classFrame" href="../../Object.html">Object</a></span>&lt;<span><a target="classFrame" href="../../String.html">String</a></span>, <span><a target="classFrame" href="../../Number.html">int</a></span>&gt;}</span>objPaneDim, <span class="$">{<span><a target="classFrame" href="../../jsx3/gui/Matrix.html">jsx3.gui.Matrix</a></span>}</span>objMatrix, <span class="$">{<span><a target="classFrame" href="../../jsx3/gui/Matrix/Column.html">jsx3.gui.Matrix.Column</a></span>}</span>objColumn, <span class="$">{<span><a target="classFrame" href="../../String.html">String</a></span>}</span>strRecordId, <span class="$">{<span><a target="classFrame" href="../../HTMLElement.html">HTMLElement</a></span>}</span>objTD)</div><div class="summarydesc">Called whenever an edit session begins.</div></td></tr><tr><td class="type"><span class="$"><span><a target="classFrame" href="../../String.html">String</a></span></span></td><td class="desc"><div class="declaration"><span><a class="member" href="#method:emEndEdit">emEndEdit</a></span>()</div><div class="summarydesc">Called when the current edit session ends.</div></td></tr><tr><td class="type"><span class="$"><span><a target="classFrame" href="../../Object.html">Object</a></span>&lt;<span><a target="classFrame" href="../../String.html">String</a></span>, <span><a target="classFrame" href="../../Object.html">Object</a></span>&gt;</span></td><td class="desc"><div class="declaration"><span><a class="member" href="#method:emGetSession">emGetSession</a></span>()</div><div class="summarydesc">Returns the state of the current edit session if this object is involved in a jsx3.gui.Matrix
edit mask session.</div></td></tr><tr><td class="type"><span class="$"><span><a target="classFrame" href="../../String.html">String</a></span></span></td><td class="desc"><div class="declaration"><span><a class="member" href="#method:emGetValue">emGetValue</a></span>()</div><div class="summarydesc">Returns the current value stored in the edit mask.</div></td></tr><tr><td class="type"><span class="$"><span class="$">void</span></span></td><td class="desc"><div class="declaration"><span><a class="member" href="#method:emInit">emInit</a></span>(<span class="$">{<span><a target="classFrame" href="../../jsx3/gui/Matrix/Column.html">jsx3.gui.Matrix.Column</a></span>}</span>objColumn)</div><div class="summarydesc">This method is called once when the edit mask is discovered by the matrix column to give it an opportunity
to initialize itself.</div></td></tr><tr><td class="type"><span class="$"><span class="$">void</span></span></td><td class="desc"><div class="declaration"><span><a class="member" href="#method:resumeEditSession">resumeEditSession</a></span>()</div><div class="summarydesc">Resumes an edit session so that the edit session will close the next time this mask loses focus.</div></td></tr><tr><td class="type"><span class="$"><span class="$">void</span></span></td><td class="desc"><div class="declaration"><span><a class="member" href="#method:suspendEditSession">suspendEditSession</a></span>()</div><div class="summarydesc">Suspends an edit session so that if this mask loses focus, the edit session does not close.</div></td></tr></table><table class="detail"><tr><th>Method Detail</th></tr></table><h3 class="detail"><a name="method:commitEditMask">commitEditMask</a></h3><div class="declaration"><span class="$"><span class="$">void</span></span> commitEditMask(<span class="$">{<span><a target="classFrame" href="../../jsx3/gui/Event.html">jsx3.gui.Event</a></span>}</span>objEvent, <span class="$">{<span><a target="classFrame" href="../../Boolean.html">boolean</a></span>}</span>bKeepOpen)</div><div class="detailcontent"><div class="detaildesc">Commits the current edit session of this edit mask.</div><h4 class="detail">Parameters:</h4><div class="indent"><div class="param"><span class="param">objEvent</span> – <span class="jsxdoc_paramdesc">the wrapped browser event that logically caused this commit to occur. If this
   parameter is provided then all the model events related to committing an edit session are triggered.</span></div><div class="param"><span class="param">bKeepOpen</span> – <span class="jsxdoc_paramdesc">if <code>true</code> then the current value of this edit mask is committed without
   closing the current edit session.
   </span></div></div></div><hr><h3 class="detail"><a name="method:emBeginEdit">emBeginEdit</a></h3><div class="declaration"><span class="$"><span><a target="classFrame" href="../../Boolean.html">boolean</a></span></span> emBeginEdit(<span class="$">{<span><a target="classFrame" href="../../String.html">String</a></span>}</span>strValue, <span class="$">{<span><a target="classFrame" href="../../Object.html">Object</a></span>&lt;<span><a target="classFrame" href="../../String.html">String</a></span>, <span><a target="classFrame" href="../../Number.html">int</a></span>&gt;}</span>objTdDim, <span class="$">{<span><a target="classFrame" href="../../Object.html">Object</a></span>&lt;<span><a target="classFrame" href="../../String.html">String</a></span>, <span><a target="classFrame" href="../../Number.html">int</a></span>&gt;}</span>objPaneDim, <span class="$">{<span><a target="classFrame" href="../../jsx3/gui/Matrix.html">jsx3.gui.Matrix</a></span>}</span>objMatrix, <span class="$">{<span><a target="classFrame" href="../../jsx3/gui/Matrix/Column.html">jsx3.gui.Matrix.Column</a></span>}</span>objColumn, <span class="$">{<span><a target="classFrame" href="../../String.html">String</a></span>}</span>strRecordId, <span class="$">{<span><a target="classFrame" href="../../HTMLElement.html">HTMLElement</a></span>}</span>objTD)</div><div class="detailcontent"><div class="detaildesc">Called whenever an edit session begins.</div><h4 class="detail">Parameters:</h4><div class="indent"><div class="param"><span class="param">strValue</span> – <span class="jsxdoc_paramdesc"></span></div><div class="param"><span class="param">objTdDim</span> – <span class="jsxdoc_paramdesc"></span></div><div class="param"><span class="param">objPaneDim</span> – <span class="jsxdoc_paramdesc"></span></div><div class="param"><span class="param">objMatrix</span> – <span class="jsxdoc_paramdesc"></span></div><div class="param"><span class="param">objColumn</span> – <span class="jsxdoc_paramdesc"></span></div><div class="param"><span class="param">strRecordId</span> – <span class="jsxdoc_paramdesc"></span></div><div class="param"><span class="param">objTD</span> – <span class="jsxdoc_paramdesc"></span></div></div><h4 class="detail">Returns:</h4><div class="indent"><code>false</code> to cancel the edit session.
   &nbsp;</div></div><hr><h3 class="detail"><a name="method:emEndEdit">emEndEdit</a></h3><div class="declaration"><span class="$"><span><a target="classFrame" href="../../String.html">String</a></span></span> emEndEdit()</div><div class="detailcontent"><div class="detaildesc">Called when the current edit session ends. This method should return the edited value.</div><h4 class="detail">Returns:</h4><div class="indent">the edited value.
   &nbsp;</div></div><hr><h3 class="detail"><a name="method:emGetSession">emGetSession</a></h3><div class="declaration">final <span class="$"><span><a target="classFrame" href="../../Object.html">Object</a></span>&lt;<span><a target="classFrame" href="../../String.html">String</a></span>, <span><a target="classFrame" href="../../Object.html">Object</a></span>&gt;</span> emGetSession()</div><div class="detailcontent"><div class="detaildesc">Returns the state of the current edit session if this object is involved in a <code>jsx3.gui.Matrix</code>
edit mask session. The state has the following keys:
<ul>
<li>matrix {jsx3.gui.Matrix}</li>
<li>column {jsx3.gui.Matrix.Column}</li>
<li>recordId {String}</li>
<li>td {HTMLElement}</li>
</ul>
</div><h4 class="detail">Returns:</h4><div class="indent">the edit session.&nbsp;</div></div><hr><h3 class="detail"><a name="method:emGetValue">emGetValue</a></h3><div class="declaration"><span class="$"><span><a target="classFrame" href="../../String.html">String</a></span></span> emGetValue()</div><div class="detailcontent"><div class="detaildesc">Returns the current value stored in the edit mask.</div><h4 class="detail">Returns:</h4><div class="indent">the current value of the edit mask.
   &nbsp;</div></div><hr><h3 class="detail"><a name="method:emInit">emInit</a></h3><div class="declaration"><span class="$"><span class="$">void</span></span> emInit(<span class="$">{<span><a target="classFrame" href="../../jsx3/gui/Matrix/Column.html">jsx3.gui.Matrix.Column</a></span>}</span>objColumn)</div><div class="detailcontent"><div class="detaildesc">This method is called once when the edit mask is discovered by the matrix column to give it an opportunity
to initialize itself.</div><h4 class="detail">Parameters:</h4><div class="indent"><div class="param"><span class="param">objColumn</span> – <span class="jsxdoc_paramdesc">the matrix column parent.
   </span></div></div></div><hr><h3 class="detail"><a name="method:resumeEditSession">resumeEditSession</a></h3><div class="declaration">final <span class="$"><span class="$">void</span></span> resumeEditSession()</div><div class="detailcontent"><div class="detaildesc">Resumes an edit session so that the edit session will close the next time this mask loses focus.</div></div><hr><h3 class="detail"><a name="method:suspendEditSession">suspendEditSession</a></h3><div class="declaration">final <span class="$"><span class="$">void</span></span> suspendEditSession()</div><div class="detailcontent"><div class="detaildesc">Suspends an edit session so that if this mask loses focus, the edit session does not close.</div></div><hr><div class="copyright">Copyright &copy; 2001-2007, TIBCO Software Inc.</div></body></html>